<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta content="Cask Data, Inc." name="author" />
<meta content="HTTP RESTful Interface to the Cask Data Application Platform" name="description" />
<meta content="Copyright © 2015-2019 Cask Data, Inc." name="copyright" />


    <meta name="git_release" content="6.1.1">
    <meta name="git_hash" content="05fbac36f9f7aadeb44f5728cea35136dbc243e5">
    <meta name="git_timestamp" content="2020-02-09 08:22:47 +0800">
    <title>CDAP HTTP RESTful API v3</title>

    <link rel="stylesheet" href="../_static/cdap-bootstrap.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="../_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" />
    <link rel="stylesheet" href="../_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/bootstrap-sphinx.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/cdap-dynamicscrollspy-4.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/jquery.mCustomScrollbar.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/cdap-jquery.mCustomScrollbar.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/abixTreeList-2.css" type="text/css" />
    <link rel="stylesheet" href="../_static/cdap-bootstrap.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/cdap-hide-toc.css" type="text/css" />

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '6.1.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  false
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <script type="text/javascript" src="../_static/language_data.js"></script>

    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="top" title="Cask Data Application Platform 6.1.1 Documentation" href="../index.html" />
    <link rel="next" title="Introduction" href="introduction.html" />
    <link rel="prev" title="Command Line Interface API" href="../cli-api.html" />
    <!-- block extrahead -->
    <meta charset='utf-8'>
    <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
    <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
    <meta name="apple-mobile-web-app-capable" content="yes">
    <!-- block extrahead end -->

</head>
<body role="document">

<!-- block navbar -->
<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
    <div class="container-fluid">
      <div class="row">
        <div class="navbar-header">
          <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
          <a class="navbar-brand" href="../table-of-contents/../../index.html">
            <span><img alt="CDAP logo" src="../_static/cdap_logo.svg"/></span>
          </a>

          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>

          <div class="pull-right">
            <div class="dropdown version-dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown"
                role="button" aria-haspopup="true" aria-expanded="false">
                v 6.1.1 <span class="caret"></span>
              </a>
              <ul class="dropdown-menu">
                <li><a href="//docs.cdap.io/cdap/5.1.2/en/index.html">v 5.1.2</a></li>
                <li><a href="//docs.cdap.io/cdap/4.3.4/en/index.html">v 4.3.4</a></li>
              </ul>
            </div>
          </div>
          <form class="navbar-form navbar-right navbar-search" action="../search.html" method="get">
            <div class="form-group">
              <div class="navbar-search-image material-icons"></div>
              <input type="text" name="q" class="form-control" placeholder="  Search" />
            </div>
            <input type="hidden" name="check_keywords" value="yes" />
            <input type="hidden" name="area" value="default" />
          </form>

          <div class="collapse navbar-collapse nav-collapse navbar-right navbar-navigation">
            <ul class="nav navbar-nav"><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="../table-of-contents/../../index.html">简介</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="../table-of-contents/../../guides.html">手册</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link current" href="../table-of-contents/../../reference-manual/index.html">参考</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="../table-of-contents/../../faqs/index.html">帮助</a></li>
            </ul>
          </div>

        </div>
      </div>
    </div>
  </div><!-- block navbar end -->
<!-- block main content -->
<div class="main-container container">
  <div class="row"><div class="col-md-2">
      <div id="sidebar" class="bs-sidenav scrollable-y-outside" role="complementary">
<!-- theme_manual: reference-manual -->
<!-- theme_manual_highlight: reference -->
<!-- sidebar_title_link: Reference -->

  <div role="note" aria-label="manuals links"><h3>Reference</h3>
    <ul class="reference-page-menu">
      <nav class="pagenav">
      <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html"> Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters.html"> Supported Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cli-api.html"> Command Line Interface API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"> HTTP RESTful API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html">Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html">Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html">Lifecycle</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html">Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html">Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html">Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="dashboard.html">Dashboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html">Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html">Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="reports.html">Reports</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="service.html">Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="workflow.html">Workflow</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../java-client-api.html"> Java Client API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../javadocs/index.html"> Javadocs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release-notes.html"> 发行说明</a></li>
<li class="toctree-l1"><a class="reference internal" href="../licenses/index.html"> Trademarks, Licenses, and Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html"> 术语表</a></li>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html"> Index</a></li>
</ul>
</nav>
    </ul>
  </div></div>
    </div><div class="col-md-8 content" id="main-content">
    
  <div class="section" id="cdap-http-restful-api-v3">
<span id="http-restful-api-v3"></span><span id="restful-api"></span><span id="http-restful-api"></span><h1>CDAP HTTP RESTful API v3<a class="headerlink" href="#cdap-http-restful-api-v3" title="Permalink to this headline">🔗</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#conventions">Conventions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="introduction.html#base-url">Base URL</a></li>
<li class="toctree-l3"><a class="reference internal" href="introduction.html#variable-replacement">Variable Replacement</a></li>
<li class="toctree-l3"><a class="reference internal" href="introduction.html#reserved-and-unsafe-characters">Reserved and Unsafe Characters</a></li>
<li class="toctree-l3"><a class="reference internal" href="introduction.html#names-and-characters-for-namespace-identifiers">Names and Characters for Namespace Identifiers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#status-codes">Status Codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#converting-from-v2-apis">Converting from V2 APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#working-with-cdap-security">Working with CDAP Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="artifact.html">Artifact</a><ul>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#add-an-artifact">Add an Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#list-available-artifacts">List Available Artifacts</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#list-artifact-versions">List Artifact Versions</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#retrieve-artifact-details">Retrieve Artifact Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#set-artifact-properties">Set Artifact Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#set-an-artifact-property">Set an Artifact Property</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#retrieve-artifact-properties">Retrieve Artifact Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#retrieve-an-artifact-property">Retrieve an Artifact Property</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#delete-artifact-properties">Delete Artifact Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#delete-an-artifact-property">Delete an Artifact Property</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#list-extensions-plugin-types-available-to-an-artifact">List Extensions (Plugin Types) available to an Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#list-plugins-available-to-an-artifact">List Plugins available to an Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#retrieve-plugin-details">Retrieve Plugin Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#delete-an-artifact">Delete an Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#load-system-artifacts">Load System Artifacts</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#delete-a-system-artifact">Delete a System Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#list-application-classes">List Application Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="artifact.html#retrieve-application-class-details">Retrieve Application Class Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#cdap-version">CDAP Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#cdap-configurations">CDAP Configurations</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#hbase-configurations">HBase Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dataset.html">Dataset</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#listing-all-datasets">Listing all Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#creating-a-dataset">Creating a Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#properties-of-an-existing-dataset">Properties of an Existing Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#metadata-of-an-existing-dataset">Metadata of an Existing Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#updating-an-existing-dataset">Updating an Existing Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#deleting-a-dataset">Deleting a Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#deleting-all-datasets">Deleting all Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#truncating-a-dataset">Truncating a Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#datasets-used-by-an-application">Datasets used by an Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#datasets-used-by-a-program">Datasets used by a Program</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataset.html#programs-using-a-dataset">Programs using a Dataset</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="lifecycle.html">Lifecycle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#application-lifecycle">Application Lifecycle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#create-an-application">Create an Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#update-an-application">Update an Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#deploy-an-artifact-and-application">Deploy an Artifact and Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#deployed-applications">Deployed Applications</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#details-of-a-deployed-application">Details of a Deployed Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#listing-versions-of-an-application">Listing Versions of an Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#delete-an-application">Delete an Application</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#program-lifecycle">Program Lifecycle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#details-of-a-program">Details of a Program</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#start-a-program">Start a Program</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#start-multiple-programs">Start Multiple Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#stop-a-program">Stop a Program</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#stop-a-program-run">Stop a Program Run</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#stop-multiple-programs">Stop Multiple Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#status-of-a-program">Status of a Program</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#status-of-multiple-programs">Status of Multiple Programs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#schedule-lifecycle">Schedule Lifecycle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#add-a-schedule">Add a Schedule</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#update-a-schedule">Update a Schedule</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#retrieving-a-schedule">Retrieving a Schedule</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#list-schedules">List Schedules</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#next-scheduled-run-time">Next Scheduled Run Time</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#delete-a-schedule">Delete a Schedule</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#schedule-disable-and-and-enable">Schedule: Disable and and Enable</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#container-information">Container Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#scaling">Scaling</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#scaling-flowlets">Scaling Flowlets</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#scaling-services">Scaling Services</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#scaling-workers">Scaling Workers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lifecycle.html#run-records">Run Records</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#retrieving-specific-run-information">Retrieving Specific Run Information</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#retrieving-run-records-in-batch">Retrieving Run Records in Batch</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#retrieving-run-counts-in-batch">Retrieving Run Counts in Batch</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#retrieving-specific-run-count">Retrieving Specific Run Count</a></li>
<li class="toctree-l3"><a class="reference internal" href="lifecycle.html#workflow-runs-suspend-and-resume">Workflow Runs: Suspend and Resume</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="logging.html">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="logging.html#downloading-application-logs">Downloading Application Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html#downloading-application-logs-for-a-run">Downloading Application Logs for a Run</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html#downloading-system-logs">Downloading System Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html#formatting-and-filtering">Formatting and Filtering</a><ul>
<li class="toctree-l3"><a class="reference internal" href="logging.html#formatting">Formatting</a></li>
<li class="toctree-l3"><a class="reference internal" href="logging.html#filtering">Filtering</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="logging.html#changing-system-service-log-levels">Changing System Service Log Levels</a><ul>
<li class="toctree-l3"><a class="reference internal" href="logging.html#setting-system-service-log-levels">Setting System Service Log Levels</a></li>
<li class="toctree-l3"><a class="reference internal" href="logging.html#resetting-system-service-log-levels">Resetting System Service Log Levels</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="logging.html#changing-program-log-levels">Changing Program Log Levels</a><ul>
<li class="toctree-l3"><a class="reference internal" href="logging.html#setting-program-log-levels">Setting Program Log Levels</a></li>
<li class="toctree-l3"><a class="reference internal" href="logging.html#resetting-program-log-levels">Resetting Program Log Levels</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata</a><ul>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#metadata-properties">Metadata Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#annotating-properties">Annotating Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#retrieving-properties">Retrieving Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#deleting-properties">Deleting Properties</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#metadata-tags">Metadata Tags</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#adding-tags">Adding Tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#retrieving-tags">Retrieving Tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#removing-tags">Removing Tags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#searching-for-metadata">Searching for Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#viewing-lineages">Viewing Lineages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#collapsing-lineage-output">Collapsing Lineage Output</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#rolling-up-lineage-output">Rolling Up Lineage Output</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#field-level-lineage">Field Level Lineage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#fields-associated-with-the-dataset">Fields associated with the Dataset</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#field-lineage-summary">Field Lineage Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="metadata.html#field-lineage-operations">Field Lineage Operations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#retrieving-metadata-for-a-program-run-deprecated">Retrieving Metadata for a Program Run (Deprecated)</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#metadata-for-custom-entities">Metadata for Custom Entities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="metrics.html">Metrics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="metrics.html#metrics-data">Metrics Data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#available-contexts">Available Contexts</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#available-system-metrics">Available System Metrics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metrics.html#searches-and-queries">Searches and Queries</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#search-for-contexts">Search for Contexts</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#search-for-metrics">Search for Metrics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="metrics.html#querying-a-metric">Querying a Metric</a><ul>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#query-examples">Query Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#query-results">Query Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#querying-for-multiple-metrics">Querying for Multiple Metrics</a><ul>
<li class="toctree-l4"><a class="reference internal" href="metrics.html#multiple-metrics-with-the-same-context">Multiple Metrics with the Same Context</a></li>
<li class="toctree-l4"><a class="reference internal" href="metrics.html#multiple-metrics-with-different-contexts">Multiple Metrics with Different Contexts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#querying-for-multiple-time-series">Querying for Multiple Time Series</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#querying-by-a-time-range">Querying by a Time Range</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#querying-by-run-id">Querying by Run-ID</a></li>
<li class="toctree-l3"><a class="reference internal" href="metrics.html#query-tips">Query Tips</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="monitor.html">Monitor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#listing-all-system-services-and-their-details">Listing all System Services and their Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#checking-the-status-of-all-system-services">Checking the Status of all System Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#checking-the-status-of-a-system-service">Checking the Status of a System Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#checking-the-status-of-a-system-upgrade">Checking the Status of a System Upgrade</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#container-information-of-a-system-service">Container Information of a System Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#restarting-system-service-instances">Restarting System Service Instances</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html#scaling-system-services">Scaling System Services</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="namespace.html">Namespace</a><ul>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#create-a-namespace">Create a Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#list-existing-namespaces">List Existing Namespaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#details-of-a-namespace">Details of a Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#editing-a-namespace">Editing a Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#deleting-a-namespace">Deleting a Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespace.html#namespace-configurations">Namespace Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dashboard.html">Dashboard</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dashboard.html#dashboard-http-rest-api">Dashboard HTTP REST API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences</a><ul>
<li class="toctree-l2"><a class="reference internal" href="preferences.html#set-preferences">Set Preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="preferences.html#get-preferences">Get Preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="preferences.html#delete-preferences">Delete Preferences</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="profile.html">Profile</a><ul>
<li class="toctree-l2"><a class="reference internal" href="profile.html#write-a-profile">Write a Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#list-profiles">List Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#retrieve-profile-details">Retrieve Profile Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#disable-profile">Disable Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#enable-profile">Enable Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#delete-profile">Delete Profile</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="query.html">Query</a><ul>
<li class="toctree-l2"><a class="reference internal" href="query.html#submitting-a-query">Submitting a Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#status-of-a-query">Status of a Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#obtaining-the-result-schema">Obtaining the Result Schema</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#retrieving-query-results">Retrieving Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#closing-a-query">Closing a Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#list-of-queries">List of Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#count-of-active-queries">Count of Active Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#download-query-results">Download Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="query.html#enabling-and-disabling-querying">Enabling and Disabling Querying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reports.html">Reports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reports.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="reports.html#reports-http-rest-api">Reports HTTP REST API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reports.html#generating-reports">Generating Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#listing-reports">Listing Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#sharing-reports">Sharing Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#viewing-report-status">Viewing Report Status</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#downloading-report-contents">Downloading Report contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#saving-reports">Saving Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="reports.html#deleting-reports">Deleting Reports</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="security.html#authorization">Authorization</a><ul>
<li class="toctree-l3"><a class="reference internal" href="security.html#grant-privileges">Grant Privileges</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#revoke-privileges">Revoke Privileges</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#list-privileges">List Privileges</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="security.html#secure-storage">Secure Storage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="security.html#add-a-secure-key">Add a Secure Key</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#retrieve-a-secure-key">Retrieve a Secure Key</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#retrieve-the-metadata-for-a-secure-key">Retrieve the Metadata for a Secure Key</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#list-all-secure-keys">List all Secure Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="security.html#remove-a-secure-key">Remove a Secure Key</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="service.html">Service</a><ul>
<li class="toctree-l2"><a class="reference internal" href="service.html#listing-all-services">Listing all Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="service.html#checking-service-availability">Checking Service Availability</a></li>
<li class="toctree-l2"><a class="reference internal" href="service.html#requesting-service-methods">Requesting Service Methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="transactions.html">Transactions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="transactions.html#number-of-invalid-transactions">Number of Invalid Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="transactions.html#truncate-invalid-transactions-by-time">Truncate Invalid Transactions by Time</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="workflow.html">Workflow</a><ul>
<li class="toctree-l2"><a class="reference internal" href="workflow.html#workflow-tokens">Workflow Tokens</a><ul>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#obtaining-a-token-s-values">Obtaining a Token’s Values</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="workflow.html#workflow-local-datasets">Workflow Local Datasets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#listing-local-datasets">Listing Local Datasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#deleting-local-datasets">Deleting Local Datasets</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="workflow.html#workflow-state">Workflow State</a></li>
<li class="toctree-l2"><a class="reference internal" href="workflow.html#workflow-statistics">Workflow Statistics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#statistics-of-successful-runs">Statistics of Successful Runs</a></li>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#comparing-a-run-to-runs-before-and-after">Comparing a Run to Runs Before and After</a></li>
<li class="toctree-l3"><a class="reference internal" href="workflow.html#comparing-two-runs">Comparing Two Runs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<p>The Cask Data Application Platform (CDAP) has an HTTP interface for a multitude of
purposes: from deploying custom applications through checking the status of system and
custom CDAP services. V3 of the API includes the namespacing of applications, data, and
metadata to achieve application and data isolation. This is an inital step towards introducing
<a class="reference external" href="http://en.wikipedia.org/wiki/Multitenancy">multi-tenancy</a> into CDAP.</p>
<p><strong>Introduction</strong></p>
<ul class="simple">
<li><a class="reference internal" href="introduction.html"><span class="doc">Introduction:</span></a> conventions, converting from HTTP RESTful API v2,
naming restrictions, status codes, and working with CDAP security</li>
</ul>
<p><strong>General APIs</strong></p>
<ul class="simple">
<li><a class="reference internal" href="namespace.html"><span class="doc">Namespace:</span></a> creating and managing namespaces</li>
<li><a class="reference internal" href="metadata.html"><span class="doc">Metadata:</span></a> setting, retrieving, and deleting user metadata annotations</li>
<li><a class="reference internal" href="preferences.html"><span class="doc">Preferences:</span></a> setting, retrieving, and deleting preferences</li>
<li><a class="reference internal" href="configuration.html"><span class="doc">Configuration:</span></a> retrieving the CDAP and HBase configurations</li>
<li><a class="reference internal" href="security.html"><span class="doc">Security:</span></a> granting, revoking and listing privileges on CDAP entities,
managing secure storage</li>
<li><a class="reference internal" href="transactions.html"><span class="doc">Transactions:</span></a> interacting with the transaction service</li>
</ul>
<p><strong>Major CDAP Entities APIs</strong></p>
<ul class="simple">
<li><a class="reference internal" href="artifact.html"><span class="doc">Artifact:</span></a> deploying artifacts and retrieving details about plugins
available to artifacts and classes contained within artifacts</li>
<li><a class="reference internal" href="lifecycle.html"><span class="doc">Lifecycle:</span></a> deploying and managing applications, and managing the
lifecycle of MapReduce programs, Spark programs, workflows, and custom services</li>
<li><a class="reference internal" href="profile.html"><span class="doc">Profile:</span></a> management of cloud runtime profiles</li>
<li><a class="reference internal" href="dataset.html"><span class="doc">Dataset:</span></a> interacting with datasets, dataset modules, and dataset types</li>
<li><a class="reference internal" href="service.html"><span class="doc">Service:</span></a> supports making requests to the methods of an application’s services</li>
<li><a class="reference internal" href="workflow.html"><span class="doc">Workflow:</span></a> retrieving values from workflow tokens and statistics on workflow runs</li>
</ul>
<p><strong>Logging, Metrics, and Monitoring APIs</strong></p>
<ul class="simple">
<li><a class="reference internal" href="logging.html"><span class="doc">Logging:</span></a> retrieving application logs</li>
<li><a class="reference internal" href="metrics.html"><span class="doc">Metrics:</span></a> retrieving metrics for system and user applications (user-defined metrics)</li>
<li><a class="reference internal" href="monitor.html"><span class="doc">Monitor:</span></a> checking the status of various system and custom CDAP services</li>
<li><a class="reference internal" href="dashboard.html"><span class="doc">Dashboard:</span></a> check in real time status of past program runs and predict future resource usage</li>
<li><a class="reference internal" href="reports.html"><span class="doc">Reports:</span></a> generate reports to understand and monitor program runs and their performance</li>
</ul>
<p class="rubric">Alphabetical List of APIs</p>
<ul class="simple">
<li><a class="reference internal" href="introduction.html"><span class="doc">Introduction:</span></a> conventions, converting from HTTP RESTful API v2,
naming restrictions, status codes, and working with CDAP security</li>
</ul>
<ul class="simple">
<li><a class="reference internal" href="artifact.html"><span class="doc">Artifact:</span></a> deploying artifacts and retrieving details about plugins
available to artifacts and classes contained within artifacts</li>
<li><a class="reference internal" href="configuration.html"><span class="doc">Configuration:</span></a> retrieving the CDAP and HBase configurations</li>
<li><a class="reference internal" href="dataset.html"><span class="doc">Dataset:</span></a> interacting with datasets, dataset modules, and dataset types</li>
<li><a class="reference internal" href="lifecycle.html"><span class="doc">Lifecycle:</span></a> deploying and managing applications, and managing the
lifecycle of MapReduce programs, Spark programs, workflows, and custom services</li>
<li><a class="reference internal" href="logging.html"><span class="doc">Logging:</span></a> retrieving application logs</li>
<li><a class="reference internal" href="metadata.html"><span class="doc">Metadata:</span></a> setting, retrieving, and deleting user metadata annotations</li>
<li><a class="reference internal" href="metrics.html"><span class="doc">Metrics:</span></a> retrieving metrics for system and user applications (user-defined metrics)</li>
<li><a class="reference internal" href="monitor.html"><span class="doc">Monitor:</span></a> checking the status of various system and custom CDAP services</li>
<li><a class="reference internal" href="namespace.html"><span class="doc">Namespace:</span></a> creating and managing namespaces</li>
<li><a class="reference internal" href="dashboard.html"><span class="doc">Dashboard:</span></a> check in real time status of past program runs and predict future resource usage</li>
<li><a class="reference internal" href="preferences.html"><span class="doc">Preferences:</span></a> setting, retrieving, and deleting preferences</li>
<li><a class="reference internal" href="query.html"><span class="doc">Query:</span></a> sending ad-hoc queries to CDAP datasets</li>
<li><a class="reference internal" href="reports.html"><span class="doc">Reports:</span></a> generate reports to understand and monitor program runs and their performance</li>
<li><a class="reference internal" href="security.html"><span class="doc">Security:</span></a> granting, revoking, and listing privileges, as well as adding, retrieving,
and managing <em>Secure Keys</em></li>
<li><a class="reference internal" href="service.html"><span class="doc">Service:</span></a> supports making requests to the methods of an application’s services</li>
<li><a class="reference internal" href="transactions.html"><span class="doc">Transactions:</span></a> interacting with the transaction service</li>
<li><a class="reference internal" href="workflow.html"><span class="doc">Workflow:</span></a> retrieving values from workflow tokens and statistics on workflow runs</li>
</ul>
</div>

</div>
    <div class="col-md-2">
      <div id="right-sidebar" class="bs-sidenav scrollable-y" role="complementary">
        <div id="localtoc-scrollspy">
        </div>
      </div>
    </div></div>
</div>
<!-- block main content end -->
<!-- block footer -->
<footer class="footer">
      <div class="container">
        <div class="row">
          <div class="col-md-2 footer-left"><a title="Command Line Interface API" href="../cli-api.html" />Previous</a></div>
          <div class="col-md-8 footer-center"><a class="footer-tab-link" href="../table-of-contents/../../reference-manual/licenses/index.html">Copyright</a> &copy; 2014-2020 Cask Data, Inc.&bull; <a class="footer-tab-link" href="//docs.cask.co/cdap/6.1.1/cdap-docs-6.1.1-web.zip" rel="nofollow">Download</a> an archive or
<a class="footer-tab-link" href="//docs.cask.co/cdap">switch the version</a> of the documentation
          </div>
          <div class="col-md-2 footer-right"><a title="Introduction" href="introduction.html" />Next</a></div>
        </div>
      </div>
    </footer>
<!-- block footer end -->
<script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script><script type="text/javascript" src="../_static/js/bootstrap-sphinx.js"></script><script type="text/javascript" src="../_static/js/abixTreeList-2.js"></script><script type="text/javascript" src="../_static/js/cdap-dynamicscrollspy-4.js"></script><script type="text/javascript" src="../_static/js/cdap-version-menu.js"></script><script type="text/javascript" src="../_static/js/copy-to-clipboard.js"></script><script type="text/javascript" src="../_static/js/jquery.mousewheel.min.js"></script><script type="text/javascript" src="../_static/js/jquery.mCustomScrollbar.js"></script><script type="text/javascript" src="../_static/js/js.cookie.js"></script><script type="text/javascript" src="../_static/js/tabbed-parsed-literal-0.2.js"></script><script type="text/javascript" src="../_static/js/cdap-onload-javascript.js"></script><script type="text/javascript" src="../_static/js/cdap-version-menu.js"></script>
    <script src="https://cdap.gitee.io/docs/cdap/json-versions.js"/></script>
  </body>
</html>